[skip changelog] document the docs generation workflow #738
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
masci
commented
Jun 3, 2020
| @@ -9,6 +9,27 @@ repository. To propose improvements or fix a bug, feel free to submit a PR. | |||
|
|
|||
| Before we can accept your contributions you have to sign the [Contributor License Agreement][0] | |||
|
|
|||
| ## Pull Requests | |||
There was a problem hiding this comment.
Unrelated to this PR, but I thought this paragraph should be upper in the page as it's more human-related than technical.
Co-authored-by: per1234 <[email protected]>
per1234
approved these changes
Jun 8, 2020
umbynos
pushed a commit
that referenced
this pull request
Jun 17, 2020
* [skip changelog] document the docs generation workflow * clarify how humans should not push to gh-pages * Apply suggestions from code review Co-authored-by: per1234 <[email protected]> Co-authored-by: per1234 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
It adds better documentation around the process we use to generated the documentation website at https://arduino.github.io/arduino-cli/
Current documentation on the topic is incomplete and slightly incorrect/outdated.
Any aspect of the process of generating docs for different versions of the Arduino CLI has been detailed.
No changes to the CLI.
These docs are intended for CLI developers, not CLI users, so I've just expanded
CONTRIBUTING.mdbut this is completely arbitrary, happy to move them to a better location if needed.See how to contribute